Description

This pull request introduces a new function, Invoke-PodeDump, to capture detailed diagnostic information during critical failures or fatal exceptions within Pode.

Key Features

1. Configurable Dump Formats:

   • Supports formats such as JSON, YAML, CLIXML, Plain Text, and Binary.

2. Pipeline Support:

   • The ErrorRecord parameter accepts pipeline input, simplifying integration with try-catch blocks.

3. Dynamic Overrides:

   • Supports runtime overrides for Path and Format.
   • Default configuration options can be set in server.psd1.

4. Optional Application Halt:

   • Includes a -Halt switch to terminate the application after saving the diagnostic dump.

Configuration in server.psd1

@{
    Server = @{
        Debug = @{
            Dump = @{
                Enable      = $true
                Format      = 'Yaml'
                Path        = './Dump'
                MaxDepth    = 5
            }
        }
    }
}

• Enable: Enable or disable memory dump functionality.
• Format: Set the default output format.
• Path: Specify the directory for saving dump files.
• MaxDepth: Define the maximum depth of information collection.

Example Usage

1. Diagnostic Dump with Halt:

   try {
       throw [System.Exception] "Simulated exception"
   }
   catch {
       $_ | Invoke-PodeDump -Format 'json' -Halt
   }

2. Custom Configuration Overrides:

   try {
       throw [System.Exception] "Simulated error"
   }
   catch {
       $_ | Invoke-PodeDump -Format 'yaml' -Path 'C:\CustomDumps'
   }

Notes

• Automatically creates directories for the specified dump path if they do not exist.
• Enhances Pode's error handling capabilities by providing detailed diagnostics for debugging.